Bankslip

info

Bankslip Payment

📘Follow this link for information on paying bankslips: Paying BANKSLIPS

Charge types

The list below, presents the Charge Types on Delfinance

BANKSLIP: Conventional bank slip

BANKSLIP_PIX: A bankslip that cointains a QR Code and can also be paid using a Pix payment method

IMPORTANT: Before creating Charges of the BANKSLIP and BANKSLIP_PIX type, it will be necessary to configure the bank account as an Authorized Bank slip Emitter or in pt-BR “Cedente”. Also note that it's recommended to use GUID as the correlationId

You can request this adjust by talking with our Operational Team through email: [email protected].

General Technical Specifications

This section aims to highlight and explain technical elements common to all operations/processes.

In addition to the Authentication process explained above, for HTTP requests, some fields that involve business rules or general specifications of Delfinance BaaS stand out.

Below are some fields present in the body of requests and deserve an additional explanation.

type - Charge Type, previously presented, which in this case must be assigned the value BANKSLIP;
correlationId - corresponds to an identifier that guarantees uniqueness to that Charge internally to a system. This field reflects the internal control used in the system of the entity that consumes this API, that is, the client.
ourNumber - corresponds to an identifier for Delfinance that allows monitoring or tracking of a Charge. This value will be displayed/recorded on Billing, and normally are presented as “Our Number”/ “Nosso Número”;
yourNumber - corresponds to an identifier for the issuer of the charge, which allows monitoring or tracking of the charge. This amount also will be displayed/recorded on the charge and are presented as "Document Number"/ “N° do Documento”.

Delfinance understood that the other fields do not present great complexity or specific rules to be followed.

Creation

Creating a conventional charge

Método POST

<https://apisandbox.delbank.com.br/baas/v1/charges>

A Cobrança Normal tem como foco o Título Simplificado que irá refletir na Carteira 112.

The Normal charge focuses on the simplified title that will be reflected in "Wallet 112"*.

Note*: Wallet is the way you choose to issue your bank slip. There are two types of wallets available: wallet 112 and wallet 121.

Given the current Billing category, it is not necessary to send the "outNumber" field, since its creation is the responsibility of Delfinance.

Request Header and Body

Content-Type: application/json
x-delbank-api-key: API Key

{
  "type": "BANKSLIP",
  "correlationId": "CORRELATIONID",
  "yourNumber": "SEUNUMERO",
  "dueDate": "yyyy-mm-dd",
  "Amount": 0.1,
  "payer": {
    "name": "fullname",
    "document": "document",
    "email": "[email protected]",
    "phone": {
      "prefix": "79",
      "number": "900000000"
    },
    "address": {
      "zipCode": "49000000",
      "publicPlace": "public place",
      "neighborhood": "neightborhood",
      "number": "000",
      "complement": "complement",
      "city": "city",
      "state": "SE"
    }
  }
}

Response Header and Body

Content-Type: application/json

{
  "type": "BANKSLIP",
  "amount": 0.1,
  "yourNumber": "SEUNUMERO",
  "ourNumber": "00000215634",
  "correlationId": "68757f64-486c-41dc-b036-4e8cb5e62576",
  "dueDate": "2023-04-01",
  "barCode": "43596930700000000100001112000000600000215634",
  "digitableLine": "43590001161200000060900002156347693070000000010",
  "payer": {
    "name": "FULANO CICLANO DA SILVA BELTRANO",
    "document": "9999999999",
    "email": "[email protected]",
    "phone": {
      "prefix": "79",
      "number": "988669383"
    },
    "address": {
      "zipCode": "49010030",
      "publicPlace": "AV. RIO BRANCO",
      "neighborhood": "CENTRO",
      "number": "186",
      "complement": "SALA 602",
      "city": "ARACAJU",
      "state": "SE"
    }
  },
  "status": "Pending",
  "updatedAt": "2022-12-07T18:16:47.347Z",
  "createdAt": "2022-12-07T18:16:47.347Z"
}

Obs.: Unsuccessful requests will respond with their respective HTTP code and the following Body:

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-fa5995742bd8906dfbaf6315d1d57d9e-e8c2cf5c14f5099f-00",
    "errors": {
        "$.dueDate": [
            "The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 4 | BytePositionInLine: 25."
        ]
    }
}

Creating an Express Charge

HTTP POST

<https://apisandbox.delbank.com.br/baas/v1/charges>

Express charge focuses on the title generated by the customer, which will be reflected in "Wallet 121"*.

NOTE*: Wallet is the way you choose to issue your bank slip. There are two types of wallets available: wallet 112 and wallet 121.

Unlike** conventional charges**, in this type of charge it is necessary to send the "ourNumber" field.

Below are instructions and a template for carrying out this operation.

Request Headers and Body

Content-Type: application/json
x-delbank-api-key: API Key

{
  "type": "BANKSLIP",
  "correlationId": "CORRELATIONID",
  "yourNumber": "SEUNUMERO",
  "ourNumber": "00160860733",
  "dueDate": "yyyy-mm-dd",
  "Amount": 0.1,
  "payer": {
    "name": "fullname",
    "document": "document",
    "email": "[email protected]",
    "phone": {
      "prefix": "79",
      "number": "900000000"
    },
    "address": {
      "zipCode": "49000000",
      "publicPlace": "public place",
      "neighborhood": "neightborhood",
      "number": "000",
      "complement": "complement",
      "city": "city",
      "state": "SE"
    }
  }
}

Response Header and Body

Content-Type: application/json

{
  "type": "BANKSLIP",
  "amount": 0.1,
  "yourNumber": "SEUNUMERO2",
  "ourNumber": "00160860733",
  "correlationId": "72b8e755-f620-4667-872f-529a87098d07",
  "dueDate": "2023-04-01",
  "barCode": "43591930700000000100001121000000600160860733",
  "digitableLine": "43590001162100000060001608607337193070000000010",
  "payer": {
    "name": "FULANO CICLANO DA SILVA BELTRANO",
    "document": "9999999999",
    "email": "[email protected]",
    "phone": {
      "prefix": "79",
      "number": "988669383"
    },
    "address": {
      "zipCode": "49010030",
      "publicPlace": "AV. RIO BRANCO",
      "neighborhood": "CENTRO",
      "number": "186",
      "complement": "SALA 602",
      "city": "ARACAJU",
      "state": "SE"
    }
  },
  "status": "Pending",
  "updatedAt": "2022-12-07T21:28:39.663Z",
  "createdAt": "2022-12-07T21:28:39.663Z"
}

Obs.: Failed requisistions will have the following HTTP and body:

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-5d3f8bf7082b9428d8461b504dae9fc0-84ffab015d792b9f-00",
    "errors": {
        "$.dueDate": [
            "The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 5 | BytePositionInLine: 25."
        ]
    }
}

Creating a Title with Guarantor/Drawer

HTTP POST

<https://apisandbox.delbank.com.br/baas/v1/charges>

This endpoint is used to create a Title, "Bank slip" (BANKSLIP) or "Bank slip pix" (BANKSLIP_PIX) with a Guarantor/Drawer (Final Beneficiary).

Request Headers and Body

Content-Type: application/json
x-delbank-api-key: API Key

    
{
  "type": "BANKSLIP",
  "correlationId": "CORRELATIONID",
  "yourNumber": "SEUNUMERO",
  "ourNumber": "00160860733",
  "dueDate": "yyyy-mm-dd",
  "Amount": 0.1,
  "payer": {
    "name": "fullname",
    "document": "document",
    "email": "[email protected]",
    "phone": {
      "prefix": "79",
      "number": "900000000"
    },
    "address": {
      "zipCode": "49000000",
      "publicPlace": "public place",
      "neighborhood": "neightborhood",
      "number": "000",
      "complement": "complement",
      "city": "city",
      "state": "SE"
    }
  },
  "finalBeneficiary": {
    "name": "fullname",
    "document": "document",
    "address": {
      "zipCode": "49000000",
      "publicPlace": "public place",
      "neighborhood": "neightborhood",
      "number": "000",
      "complement": "complement",
      "city": "city",
      "state": "SE"
    }
  }
}

Response Header and Body

Content-Type: application/json

{
  "type": "BANKSLIP",
  "amount": 0.1,
  "yourNumber": "SEUNUMERO2",
  "ourNumber": "00160860733",
  "correlationId": "72b8e755-f620-4667-872f-529a87098d07",
  "dueDate": "2023-04-01",
  "barCode": "43591930700000000100001121000000600160860733",
  "digitableLine": "43590001162100000060001608607337193070000000010",
  "payer": {
    "name": "FULANO CICLANO DA SILVA BELTRANO",
    "document": "9999999999",
    "email": "[email protected]",
    "phone": {
      "prefix": "79",
      "number": "988669383"
    },
    "address": {
      "zipCode": "49010030",
      "publicPlace": "AV. RIO BRANCO",
      "neighborhood": "CENTRO",
      "number": "186",
      "complement": "SALA 602",
      "city": "ARACAJU",
      "state": "SE"
    }
  },
  "status": "Pending",
  "updatedAt": "2022-12-07T21:28:39.663Z",
  "createdAt": "2022-12-07T21:28:39.663Z"
}

Obs.: Failed requisistions will have the following HTTP and body:

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-3d4d68882c19524d921cc791e2a5e7ee-166c8e241265c3d3-00",
    "errors": {
        "$.dueDate": [
            "The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 6 | BytePositionInLine: 25."
        ]
    }
}

Creating a Title with Guarantor/Drawer

HTTP POST

<https://apisandbox.delbank.com.br/baas/v1/charges>

This endpoint is used to create a Charge of type "Pix Bank Slip". In this modality, the **Title **will be issued in Wallet 112

Request Headers and Body

Content-Type: application/json
x-delbank-api-key: API Key

{
  "type": "BANKSLIP_PIX",
  "yourNumber": "SEUNUMERO",
  "correlationId": "72b8e755-f620-4667-872f-529a87098d07",//uid único para cada request
  "dueDate": "yyyy-mm-dd",
  "Amount": 0.1,
  "payer": {
    "name": "fullname",
    "document": "document",
    "email": "[email protected]",
    "phone": {
      "prefix": "79",
      "number": "900000000"
    },
		"address": {
      "zipCode": "49000000",
      "publicPlace": "public place",
      "neighborhood": "neightborhood",
      "number": "000",
      "complement": "complement",
      "city": "city",
      "state": "SE"
    }
  },
  "discount": {
    "type": "Fixed",
    "items": [
      {
        "date": "yyyy-mm-dd",
        "amount": 0.01
      },
      {
        "date": "yyyy-mm-dd",
        "amount": 0.01
      },
      {
        "date": "yyyy-mm-dd",
        "amount": 0.01
      }
    ]
  },
  "lateFine": {
    "type": "Percentage",
    "date": "yyyy-mm-dd",
    "amount": 2.5
  },
  "latePayment": {
    "type": "Fixed",
    "date": "yyyy-mm-dd",
    "amount": 2.5
  }
}

Response Header and Body

Content-Type: application/json

{
    "type": "BANKSLIP_PIX",
    "correlationId": "69577abe-3867-4e0b-85ee-21aa6bc9db9b",
    "amount": 0.1,
    "walletNumber": "112",
    "yourNumber": "SEUNUMERO",
    "ourNumber": "00000532665",
    "dueDate": "2025-06-05T23:59:59.999Z",
    "qrCode": "00020101021226770014br.gov.bcb.pix2555pix-h.delbank.com.br/v2/cobv/vcharge00000000000003246005204000053039865802BR5907DELBANK6004CITY62070503***63045ED1",
    "qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAANSU",
    "barCode": "43599110300000000100001112000001700000532665",
    "digitableLine": "43590001161200000170600005326657911030000000010",
    "payer": {
        "name": "fullname",
        "document": "12345678910",
        "email": "[email protected]",
        "phone": {
            "prefix": "79",
            "number": "900000000"
        },
        "address": {
            "zipCode": "49000000",
            "publicPlace": "public place",
            "neighborhood": "neightborhood",
            "number": "000",
            "complement": "complement",
            "city": "city",
            "state": "SE"
        }
    },
    "discount": {
        "type": "Fixed",
        "items": [
            {
                "date": "2025-03-01T00:00:00Z",
                "amount": 0.01
            },
            {
                "date": "2025-03-02T00:00:00Z",
                "amount": 0.01
            },
            {
                "date": "2025-03-03T00:00:00Z",
                "amount": 0.01
            }
        ]
    },
    "lateFine": {
        "type": "Percentage",
        "date": "2025-07-03T00:00:00Z",
        "amount": 2.5
    },
    "latePayment": {
        "type": "Fixed",
        "date": "2025-07-01T00:00:00Z",
        "amount": 2.5
    },
    "status": "Pending",
    "payments": [],
    "additionalInfo": [
        {
            "key": "YourNumber",
            "value": "SEUNUMERO"
        },
        {
            "key": "OurNumber",
            "value": "00000532665"
        },
        {
            "key": "DigitableLine",
            "value": "43590001161200000170600005326657911030000000010"
        }
    ],
    "updatedAt": "2025-02-05T20:59:25.0161344Z",
    "createdAt": "2025-02-05T20:59:24.0194394Z"
}

Obs.: Failed requisistions will have the following HTTP and body:

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-61a3e8c33796e9a3ff0af8052db87afc-ea172db465a74b7f-00",
    "errors": {
        "$.dueDate": [
            "The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 4 | BytePositionInLine: 25."
        ]
    }
}

Creating a Title with discount, fine and late payment

HTTP POST

<https://apisandbox.delbank.com.br/baas/v1/charges>

This endpoint is used to create a Charge of type "Pix Bank Slip". In this modality, the **Title **will be issued in Wallet 112

Request Headers and Body

Content-Type:application/json
x-delbank-api-key:Api Key

{
  "type": "BANKSLIP_PIX",
  "correlationId": "SEUIDSEUIDSEUID",
  "yourNumber": "SEUNUMEROSEU",
  "dueDate": "2023-04-01",
  "Amount": 0.1,
  "payer": {
    "name": "FULANO CICLANO",
    "document": "16166823533",
    "email": "[email protected]",
    "phone": {
      "prefix": "79",
      "number": "988669383"
    },
    "address": {
      "zipCode": "49010030",
      "publicPlace": "AV. RIO BRANCO",
      "neighborhood": "CENTRO",
      "number": "186",
      "complement": "SALA 602",
      "city": "ARACAJU",
      "state": "SE"
    }
  },
  "discount": {
    "type": "Fixed",
    "items": [
      {
        "date": "2023-03-26",
        "amount": 0.01
      },
      {
        "date": "2023-03-27",
        "amount": 0.01
      },
      {
        "date": "2023-03-28",
        "amount": 0.01
      }
    ]
  },
  "lateFine": {
    "type": "Percentage",
    "date": "2023-04-02",
    "amount": 2.5
  },
  "latePayment": {
    "type": "Fixed",
    "date": "2023-04-02",
    "amount": 2.5
  }
}

Response Header and Body

Content-Type:application/json

{
    "type": "BANKSLIP_PIX",
    "correlationId": "f20868e7-1cda-4a61-92fc-b076133123d9",
    "amount": 0.1,
    "walletNumber": "112",
    "yourNumber": "SEUNUMEROSEU",
    "ourNumber": "00000532673",
    "dueDate": "2026-04-01T23:59:59.999Z",
    "qrCode": "00020101021226770014br.gov.bcb.pix2555pix-h.delbank.com.br/v2/cobv/vcharge00000000000003246015204000053039865802BR5907DELBANK6007ARACAJU62070503***63042FAD",
    "qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAANS",
    "barCode": "43591140300000000100001112000001700000532673",
    "digitableLine": "43590001161200000170600005326731114030000000010",
    "payer": {
        "name": "FULANO CICLANO",
        "document": "16166823533",
        "email": "[email protected]",
        "phone": {
            "prefix": "79",
            "number": "988669383"
        },
        "address": {
            "zipCode": "49010030",
            "publicPlace": "AV. RIO BRANCO",
            "neighborhood": "CENTRO",
            "number": "186",
            "complement": "SALA 602",
            "city": "ARACAJU",
            "state": "SE"
        }
    },
    "discount": {
        "type": "Fixed",
        "items": [
            {
                "date": "2026-03-26T00:00:00Z",
                "amount": 0.01
            },
            {
                "date": "2026-03-27T00:00:00Z",
                "amount": 0.01
            },
            {
                "date": "2026-03-28T00:00:00Z",
                "amount": 0.01
            }
        ]
    },
    "lateFine": {
        "type": "Percentage",
        "date": "2026-04-02T00:00:00Z",
        "amount": 2.5
    },
    "latePayment": {
        "type": "Fixed",
        "date": "2026-04-02T00:00:00Z",
        "amount": 2.5
    },
    "status": "Pending",
    "payments": [],
    "additionalInfo": [
        {
            "key": "YourNumber",
            "value": "SEUNUMEROSEU"
        },
        {
            "key": "OurNumber",
            "value": "00000532673"
        },
        {
            "key": "DigitableLine",
            "value": "43590001161200000170600005326731114030000000010"
        }
    ],
    "updatedAt": "2025-02-05T21:00:50.9660452Z",
    "createdAt": "2025-02-05T21:00:50.9630728Z"
}

Requisições malsucedidas responderão com seu respectivo código HTTP e o seguinte corpo:

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-7a12cadb81f68cdb4dae6b62afadd36b-55605d5867652ca6-00",
    "errors": {
        "$.dueDate": [
            "The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 4 | BytePositionInLine: 25."
        ]
    }
}

Attributes

Here are all the attributes that can be passed for bankslip creation:

Name	Type	Description	Max characters
type	`enum`	Required. Indicates the type of transaction, `BANKSLIP_PIX` or `BANKSLIP`.	-
correlationId	`string`	Required. Unique identifier for conciliation with the client system.	36
ourNumber	`string`	Our number assigned to the charge.	11
yourNumber	`string`	Required. Client's reference number for the charge.	15
voidDate	`date`	Date when the charge becomes invalid (format: `YYYY-MM-DD`).	10
dueDate	`date`	Required. Due date for the charge, after this date the fines will become active (format: `YYYY-MM-DD`).	10
Amount	`number`	Required. Value of the charge.	18+2
payer	`object`	Required. Payer information, including name, document, email, phone, and address.	-
payer.name	`string`	Full name of the payer.	40
payer.document	`string`	Payer's document number (e.g., CPF or CNPJ).	14
payer.email	`string`	Payer's email address.	50
payer.phone	`object`	Payer's phone number, including prefix and number.	-
payer.phone.prefix	`string`	Prefix of the phone number (e.g., area code).	2
payer.phone.number	`string`	Payer's phone number.	9
payer.address	`object`	Payer's address information.	-
payer.address.zipCode	`string`	ZIP code of the payer's address.	8
payer.address.publicPlace	`string`	Public place (e.g., street or avenue) of the payer's address.	150
payer.address.neighborhood	`string`	Neighborhood of the payer's address.	15
payer.address.number	`string`	Address number.	15
payer.address.complement	`string`	Address complement (e.g., apartment or suite).	30
payer.address.city	`string`	City of the payer's address.	50
payer.address.state	`string`	State of the payer's address (e.g., SP, RJ).	2
discount	`object`	Discount information applied to the charge.	-
discount.type	`enum`	Type of discount (e.g., `Fixed` or `PERCENTAGE`).	-
discount.items	`array`	List of discount items, each with a date and amount.	-
discount.items.date	`date`	Date when the discount is applied (format: `YYYY-MM-DD`).	10
discount.items.amount	`number`	Amount of the discount.	18+2
lateFine	`object`	Late fine information applied to the charge.	-
lateFine.type	`enum`	Type of late fine (e.g., `FIXED` or `Percentage`).	-
lateFine.date	`date`	Date when the late fine is applied (format: `YYYY-MM-DD`).	10
lateFine.amount	`number`	Amount or percentage of the late fine.	18+2
latePayment	`object`	Late payment information applied to the charge.	-
latePayment.type	`enum`	Type of late payment (e.g., `Fixed` or `PERCENTAGE`).	-
latePayment.date	`date`	Date when the late payment is applied (format: `YYYY-MM-DD`).	10
latePayment.amount	`number`	Amount of the late payment.	18+2

Staging Environment

Following the endpoints to facilitate tests in staging environment

Charge payment [POST]

<https://apisandbox.delbank.com.br/baas/v1/charges/correlationId/pay>

The charge payment route is an approval route for integration testing and validation of notifications. For paying a bankslip, please follow this link: <https://docs.delbank.com.br/reference/pagamento-de-boleto>

Request Header

x-delbank-api-key: API Key

Response Header

Content-Type:application/json

Obs.: Failed requisistions will have the following HTTP and body:

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
    "title": "Not Found",
    "status": 404,
    "traceId": "00-9954e85487cfc65b8841f40c572d181b-d5bf166c3d9c1c1a-00"
}

Charge Expiration [PUT]

<https://apisandbox.delbank.com.br/baas/v1/charges/correlationId/expire>

The charge expiration route is also an approval route for integration testing and validation of notifications.

NOTE: It will affect the original expiration date of the charge entered.

Request header

x-delbank-api-key:Api Key

Response Header

Content-Type:application/json

Obs.: Failed requisistions will have the following HTTP and body:

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
    "title": "Not Found",
    "status": 404,
    "traceId": "00-2229624b5844efe7720e367e25a6bbc8-dea6734e79cf24f8-00"
}

Bankslip Payment​

Charge types​

General Technical Specifications

Creation

Creating a conventional charge​

Request Header and Body​

Response Header and Body​

Creating an Express Charge​

Request Headers and Body​

Response Header and Body​

Creating a Title with Guarantor/Drawer​

Request Headers and Body​

Response Header and Body​

Creating a Title with Guarantor/Drawer​

Request Headers and Body​

Response Header and Body​

Creating a Title with discount, fine and late payment​

Request Headers and Body​

Response Header and Body​

Attributes​

Staging Environment

Charge payment [POST]​

Request Header​

Response Header​

Charge Expiration [PUT]​

Request header​

Response Header​

Bankslip Payment

Charge types

Creating a conventional charge

Request Header and Body

Response Header and Body

Creating an Express Charge

Request Headers and Body

Response Header and Body

Creating a Title with Guarantor/Drawer

Request Headers and Body

Response Header and Body

Creating a Title with Guarantor/Drawer

Request Headers and Body

Response Header and Body

Creating a Title with discount, fine and late payment

Request Headers and Body

Response Header and Body

Attributes

Charge payment [POST]

Request Header

Response Header

Charge Expiration [PUT]

Request header

Response Header